/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2012 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://github.com/payara/Payara/blob/main/LICENSE.txt
 * See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at legal/OPEN-SOURCE-LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package org.glassfish.security.services.api.authorization;


/**
 * The AzResult class represents the result of an authorization decision.  The result includes three distinct results:
 * A result status, which indicates whether the call was successful or not, and may indicate a reason for a failed call;
 * an authorization decision, which is valid only if the status is "OK", and obligations, which represent actions the
 * calling code must take if it proceeds to access the resource in question.  Obligations are expressed as attributes;
 * the meaning of any specific obligation is established by an out-of-band agreement between the PDP and the PEP.
 */
public interface AzResult {
	
	/**
	 * The possible authorization decision values.  These carry the same meaning as the corresponding
	 * decision values defined by XACML 2.0 and later.
	 */
	public enum Decision { PERMIT, DENY, INDETERMINATE, NOT_APPLICABLE };
	/**
	 * The possible authorization status values.  These carry the same meaning as the corresponding
	 * status values defined by XACML 2.0 and later.
	 */
	public enum Status { OK, MISSING_ATTRIBUTE, PROCESSING_ERROR, SYNTAX_ERROR };
	
	/**
	 * Get the authorization decision value for this AzResult.
	 * 
	 * @return The Decision value.
	 */
	public Decision getDecision();
	
	/**
	 * Get the authorization status value for this AzResult.
	 * 
	 * @return The Status value.
	 */
	public Status getStatus();
	
	/**
	 * Return the obligations that apply to this result.
	 * 
	 * @return The AzObligations.
	 */
	public AzObligations getObligations();

}
